home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / pckerm21.zip / PCKERMIT.DOC < prev    next >
Text File  |  1987-08-21  |  21KB  |  517 lines
  1. PCKERMIT.DOC                                             August 21, 1987
  2.  
  3. MS-DOS Kermit with Sliding Windows                           Version 2.1
  4. ----------------------------------
  5.  
  6.  
  7.                         PCKERMIT.EXE USER GUIDE
  8.                         =======================
  9.  
  10. Introduction
  11. ------------
  12.  
  13.      PCKERMIT version 2.1 is an implementation of the "Sliding Window
  14. Extension" to Kermit (the extension is popularly called SuperKermit).
  15. This extension allows data packets to be sent continuously under most
  16. conditions, unlike "Kermit Classic" or XMODEM, both of which must wait
  17. for the other side to return an acknowledgement after each data packet
  18. has been sent.
  19.  
  20.      This continuous transmission of data is especially helpful when
  21. there are delays in the communications path, such as via satellite
  22. transmission or over the public data networks (Telenet, Uninet, Tymnet,
  23. etc).
  24.  
  25.  
  26. NOT A TERMINAL PROGRAM
  27. ----------------------
  28.  
  29.      PCKERMIT.EXE is not a terminal program.  It simply implements the
  30. Kermit protocol, including the sliding window extension.  It will work
  31. with older "Kermit Classic" implementations as well, via automatic
  32. negotiation between the two Kermit programs.
  33.  
  34.      PCKERMIT.EXE runs as a "one-shot" execution then returns to the
  35. caller.  A single file or multiple files (wildcard filename) are
  36. transferred until execution is completed or the transfer is abnormally
  37. aborted.  If execution is performed by the user from the DOS command
  38. line, termination of PCKERMIT returns control to MS-DOS.
  39.  
  40.  
  41. USE OF PCKERMIT.EXE
  42. -------------------
  43.  
  44.      PCKERMIT does not establish a carrier with a remote system.  The
  45. connection must be established using a separate terminal program, and
  46. the remote Kermit selected using the separate terminal program.  Then
  47. you return to the MS-DOS prompt and start PCKERMIT for the actual file
  48. transfer.
  49.  
  50.      The command syntax of the stand-alone Kermit program is shown in
  51. Figure 1.  Here are examples of execution from the DOS command line:
  52.  
  53. PCKERMIT
  54.    or
  55. PCKERMIT -H             Help: Will give you the screen of figure 1 below
  56.  
  57. PCKERMIT -R             Receive: Will receive a file using the PCKERMIT
  58.                         defaults of 1200 baud, parity none, on COM1.
  59.  
  60. PCKERMIT -S filename.ext  Send: Will send a file using the PCKERMIT
  61.                           defaults of 1200 baud, parity none, on COM1.
  62.  
  63.  
  64. PCKERMIT -R -P M        Receive: Will receive a file using Parity Mark
  65.  
  66.  
  67. PCKERMIT -L COM2 -B 2400 -P M -R
  68.  
  69.                         This will use serial line COM2 at 2400 baud and
  70.                         parity of mark to receive a file.
  71.  
  72.      Upper or lower case does not matter; neither does the order of the
  73. options (i.e., PCKERMIT -R -P M  will do the same as PCKERMIT -P M -R).
  74.  
  75.  
  76.  
  77. Start of Figure 1
  78.  
  79. Figure 1. PCKERMIT command syntax.
  80.  
  81.   PCKERMIT version 2.1, August 21, 1987, by Jan A. van der Eijk
  82.   Kermit Receive and Send protocol module for MS-DOS operating systems.
  83.   Usage: PCKERMIT [-x arg [-x arg]...[-yyy]..]]
  84.   x is an option that requires an argument, y an option with no argument:
  85.      -s file(s)   send
  86.      -r           receive
  87.      -a name      alternate name, used with -s, -r
  88.      -h           help - print this message
  89.   settings --                                                        default
  90.      -l line      communication line device ( COM1, COM2 )            [COM1]
  91.      -b baud      line speed, e.g. 1200                               [1200]
  92.      -p x         parity, x is one of e,o,m,s,n                        [N]
  93.      -m size      maximum window size to use ( <= 31 )                 [16]
  94.      -n           non binary file transfer, affect CR/LF
  95.      -t           line turnaround handshake = xon, half duplex
  96.      -w           write over preexisting files
  97.      -q           be quiet during file transfer
  98.      -c           carrier detect signal required to be present
  99.  
  100.  
  101. Note 1:  If -t is used, -m should not be used.
  102.  
  103. Note 2:  The usage of -w is reversed from standard Columbia CKERMIT.
  104.  
  105.  
  106. End of Figure 1
  107.  
  108.  
  109.  
  110. USE OF BATCH FILES
  111. ------------------
  112.  
  113.      Two small batch files can greatly simplify use of PCKERMIT:
  114.  
  115.  
  116.      SEND.BAT would look like this using Mark parity at 1200 baud on
  117. COM1:
  118.  
  119. PCKERMIT -P M -S %1
  120.  
  121.  
  122.      REC.BAT would look like this using Mark parity at 1200 baud on
  123. COM1:
  124.  
  125. PCKERMIT -P M -R
  126.  
  127.      This makes it easy to send a file by just typing
  128.  
  129. SEND filename.ext
  130.  
  131.      and receive a file by typing
  132.  
  133. REC
  134.  
  135. at the MS-DOS prompt.  Change the PCKERMIT command line to reflect your
  136. communications setup (add -B 300 for 300 baud, etc.).
  137.  
  138.      You could include the name of your terminal software at the end of
  139. the batch file so you went directly back to your terminal software when
  140. finished with the transfer.
  141.  
  142.  
  143. CHARACTERS DISPLAYED DURING TRANSFER
  144. ------------------------------------
  145.  
  146.      During operation of the standalone PCKERMIT it may display the
  147. following:
  148.  
  149.     %   Resend of last packet
  150.     .   Is printed every FOURTH data packet
  151.     A   Attributes packet (file length and creation date)
  152.     B   End of transmission packet
  153.     F   File Header
  154.     N   NAK packet
  155.     Q   Bad checksum or other packet error
  156.     S   Send-Init packet
  157.     T   Timeout
  158.     Z   End of file packet
  159.  
  160.  
  161. KEYBOARD INTERRUPTS
  162. -------------------
  163.  
  164.      During a file transfer PCKERMIT responds (sometimes slowly) to the
  165. following keystrokes:
  166.  
  167. CTRL-F to cancel File, CTRL-R to Resend current packet.
  168. CTRL-B to cancel Batch, CTRL-K to abort Kermit and exit.
  169. CTRL-A for status report:
  170.  
  171.      These functions are available even at the start of PCKERMIT before
  172. it tells you they are available.  In particular, Control-K can be used
  173. if the "Send-Init" exchange does not seem to be working.
  174.  
  175.      Please note that PCKERMIT checks the keyboard infrequently under
  176. some conditions.  WAIT at least 20 - 30 seconds before repeating a
  177. keystroke in order to avoid stacking up repeated commands.  This is
  178. particularly true of CTRL-F (cancel file) where you might cancel more
  179. than one file.
  180.  
  181.      Also, the Control-F and Control-B (cancel file and cancel batch)
  182. functions sometimes require a NAK and a resend or a timeout before they
  183. actually work.  This is not a protocol problem, but is due to the way
  184. PCKERMIT flushes it buffer before sending the abort packet.  In some
  185. cases, the flushing of the buffer truncates a packet and the following
  186. abort packet is not seen as a separate packet.
  187.  
  188.      Here is a more detailed explanation of the functions:
  189.  
  190.   CTRL-F will cancel an individual file in a wildcard transaction,
  191.   but then continue with the next file in the batch.
  192.  
  193.   CTRL-B will cancel the entire batch of files, according to
  194.   protocol, and then return you to the DOS prompt.
  195.  
  196.   CTRL-K will abort the file transfer and return you to the DOS
  197.   prompt.  PCKERMIT sends an Error packet indicating it is
  198.   aborting, but otherwise does not worry about protocol.
  199.  
  200.   CTRL-R will resend the current packet; this can be used as a
  201.   manual timeout.  With windowing is in effect, this feature should be
  202.   tried only as a last resort as it has not been fully tested.
  203.  
  204.   CTRL-A will give you a status report on the screen.  The items
  205.   covered are:
  206.  
  207. CONTROL-A STATUS REPORT
  208. -----------------------
  209.                                COMMENTS
  210. ^A  Status report:
  211.  file type: binary            Details unknown
  212.  
  213.  file number: 1               Indicates which file of a multiple file
  214.                               wildcard batch transfer
  215.  
  216.  characters : 1291            On SEND: indicates number of characters
  217.                               output to the buffer, but not necessarily
  218.                               yet sent out the modem.
  219.  
  220.                               On RECEIVE: indicates characters actually
  221.                               written to disk so far; others may already
  222.                               have been received to memory.
  223.  
  224.  window size: 31              The window size agreed upon after negotiation
  225.                               with the other Kermit.  By definition, 0 means
  226.